GET Documents/ByTask?tasks[0]={tasks[0]}&tasks[1]={tasks[1]}&filterByTaskItemType[0]={filterByTaskItemType[0]}&filterByTaskItemType[1]={filterByTaskItemType[1]}
Gets documents for the specified tasks.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
tasks |
The tasks. |
Collection of globally unique identifier |
Required |
filterByTaskItemType | Collection of TaskItemTypes |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ExtendedDocumentDTOName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
FileName |
File Name |
string |
None. |
Viewable |
Determines that Document is viewable or not |
boolean |
None. |
MimeType |
Mime Type |
string |
None. |
Kind |
Kind |
string |
None. |
Length |
Returns Length of Document |
integer |
None. |
ItemID |
ID of item |
globally unique identifier |
None. |
CreatedOn | date |
None. |
|
ContentModifiedOn |
The time the content of the document was last modified. |
date |
None. |
ContentCreatedOn |
The time the content of the document was first persisted to the database. |
date |
None. |
ItemTitle |
Item Title |
string |
None. |
Description |
Description |
string |
None. |
ParentDocumentID |
ID of Parent Document |
globally unique identifier |
None. |
UploadedByID |
The ID of the user that uploaded the document |
globally unique identifier |
None. |
UploadedBy |
Returns who uploaded the document |
string |
None. |
RevisionSetID |
ID of Revision set |
globally unique identifier |
None. |
RevisionDescription |
Revision Description |
string |
None. |
MajorVersion |
Returns Major version |
integer |
None. |
MinorVersion |
Returns Minor version |
integer |
None. |
BuildVersion |
Returns the build version |
integer |
None. |
RevisionVersion |
Returns Revision version |
integer |
None. |
TaskItemType |
Gets or sets the associated task item type for the document if it exists. |
TaskItemTypes |
None. |
DocumentType |
Gets or Sets if the Document was Input or Output from the DMC |
RequestDocumentType |
None. |
ID | globally unique identifier |
None. |
|
Timestamp | Collection of byte |
None. |
Response Formats
application/json, text/json
{ "results": [ { "Name": "sample string 1", "FileName": "sample string 2", "Viewable": true, "MimeType": "sample string 4", "Kind": "sample string 5", "Length": 6, "ItemID": "e3219768-b589-4dbe-aa02-b0dc60ad8744", "CreatedOn": "2024-05-15T23:25:03Z", "ContentModifiedOn": "2024-05-15T23:25:03Z", "ContentCreatedOn": "2024-05-15T23:25:03Z", "ItemTitle": "sample string 9", "Description": "sample string 10", "ParentDocumentID": "9e2c6b00-5409-4db6-9dbe-e5d32666db15", "UploadedByID": "2bf6c158-4f19-4941-b7ac-1e9b3eb59f2c", "UploadedBy": "sample string 11", "RevisionSetID": "ce781e0f-e753-4e71-a226-b02ef46faeab", "RevisionDescription": "sample string 12", "MajorVersion": 13, "MinorVersion": 14, "BuildVersion": 15, "RevisionVersion": 16, "TaskItemType": 1, "DocumentType": 0, "ID": "243db1ad-7d61-496f-b1a6-61d2e606cae6", "Timestamp": "QEA=" }, { "Name": "sample string 1", "FileName": "sample string 2", "Viewable": true, "MimeType": "sample string 4", "Kind": "sample string 5", "Length": 6, "ItemID": "e3219768-b589-4dbe-aa02-b0dc60ad8744", "CreatedOn": "2024-05-15T23:25:03Z", "ContentModifiedOn": "2024-05-15T23:25:03Z", "ContentCreatedOn": "2024-05-15T23:25:03Z", "ItemTitle": "sample string 9", "Description": "sample string 10", "ParentDocumentID": "9e2c6b00-5409-4db6-9dbe-e5d32666db15", "UploadedByID": "2bf6c158-4f19-4941-b7ac-1e9b3eb59f2c", "UploadedBy": "sample string 11", "RevisionSetID": "ce781e0f-e753-4e71-a226-b02ef46faeab", "RevisionDescription": "sample string 12", "MajorVersion": 13, "MinorVersion": 14, "BuildVersion": 15, "RevisionVersion": 16, "TaskItemType": 1, "DocumentType": 0, "ID": "243db1ad-7d61-496f-b1a6-61d2e606cae6", "Timestamp": "QEA=" } ] }
text/javascript
{"results":[{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"e3219768-b589-4dbe-aa02-b0dc60ad8744","CreatedOn":"2024-05-15T23:25:03Z","ContentModifiedOn":"2024-05-15T23:25:03Z","ContentCreatedOn":"2024-05-15T23:25:03Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"9e2c6b00-5409-4db6-9dbe-e5d32666db15","UploadedByID":"2bf6c158-4f19-4941-b7ac-1e9b3eb59f2c","UploadedBy":"sample string 11","RevisionSetID":"ce781e0f-e753-4e71-a226-b02ef46faeab","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"243db1ad-7d61-496f-b1a6-61d2e606cae6","Timestamp":"QEA="},{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"e3219768-b589-4dbe-aa02-b0dc60ad8744","CreatedOn":"2024-05-15T23:25:03Z","ContentModifiedOn":"2024-05-15T23:25:03Z","ContentCreatedOn":"2024-05-15T23:25:03Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"9e2c6b00-5409-4db6-9dbe-e5d32666db15","UploadedByID":"2bf6c158-4f19-4941-b7ac-1e9b3eb59f2c","UploadedBy":"sample string 11","RevisionSetID":"ce781e0f-e753-4e71-a226-b02ef46faeab","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"243db1ad-7d61-496f-b1a6-61d2e606cae6","Timestamp":"QEA="}]}
application/bson
Binary JSON content. See http://bsonspec.org for details.
application/xml
Sample not available.
text/xml
Sample not available.